Add section about user impact to PR template #8003
Conversation
| @@ -9,12 +9,16 @@ | |||
| 1. `x.java` | |||
| 2. `y.python` | |||
|
|
|||
| ## 🚨 User Impact 🚨 | |||
| Are there any breaking changes? | |||
| What is the end result perceived by the user? | |||
There was a problem hiding this comment.
I think it's probably more useful to put this in the connector README than in PR description? People usually won't check this.
There was a problem hiding this comment.
the goal of this is to get the developer to think about the end impact this particular PR they are raising will have on the user especially if it contains a breaking change. If there is a breaking change, then we want to make sure it is:
- very thoroughly considered
- is communicated to users clearly perhaps via something like #8004
this way, if there are any breaking issues or action required from the user, or just anything they really need to be aware of, this section will bring that to the forefront.
as such, it feels like a README is the wrong place for this, as it is meant as a device to alert the developer that they need to think about the user
There was a problem hiding this comment.
Got it. Make sense.
I was actually thinking about the connector doc, but I wrote down "README" by mistake. It is probably also worth adding alert about breaking changes to the CHANGELOG section of the connector doc.
Co-authored-by: LiRen Tu <tuliren@gmail.com>
| ## Pre-merge Checklist | ||
| Expand the relevant checklist and delete the others. | ||
|
|
||
| <details><summary> <strong> New Connector </strong></summary> | ||
| <p> | ||
|
|
There was a problem hiding this comment.
Oh, sorry that I did not mean to delete this whole line. Just wanted to remove the newly-introduced spaces.
Co-authored-by: LiRen Tu <tuliren@gmail.com>
What
Add a section to the PR template which prompts the developer to think about the user impact of their change
the goal of this is to get the developer to think about the end impact this particular PR they are raising will have on the user especially if it contains a breaking change. If there is a breaking change, then we want to make sure it is:
this way, if there are any breaking issues or action required from the user, or just anything they really need to be aware of, this section will bring that to the forefront